Vcenter NamespaceManagement Software Clusters Info

Vcenter NamespaceManagement Software Clusters Info
Vcenter NamespaceManagement Software Clusters Info

The Vcenter NamespaceManagement Software Clusters Info schema contains detailed information about the cluster upgrade status and related information.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "current_version": "string",
    "available_versions": [
        "string"
    ],
    "last_upgraded_date": "string",
    "messages": [
        {
            "severity": "string",
            "details": {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi Std NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            }
        }
    ],
    "state": "string",
    "upgrade_status": {
        "desired_version": "string",
        "messages": [
            {
                "severity": "string",
                "details": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                }
            }
        ],
        "progress": {
            "total": 0,
            "completed": 0,
            "message": {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi Std NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            }
        },
        "components": [
            {
                "type": "string",
                "description": {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                },
                "status": "string",
                "last_transition_time": "string",
                "reason": "string",
                "severity": "string",
                "messages": [
                    {
                        "severity": "string",
                        "details": {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        },
                        "kb_article_link": "string",
                        "id": "string"
                    }
                ]
            }
        ]
    },
    "upgrade_prechecks": [
        {
            "type": "string",
            "description": {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi Std NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            },
            "status": "string",
            "last_transition_time": "string",
            "reason": "string",
            "severity": "string",
            "messages": [
                {
                    "severity": "string",
                    "details": {
                        "id": "string",
                        "default_message": "string",
                        "args": [
                            "string"
                        ],
                        "params": {
                            "params": {
                                "s": "string",
                                "dt": "string",
                                "i": 0,
                                "d": "number",
                                "l": "Vapi Std NestedLocalizableMessage Object",
                                "format": "string",
                                "precision": 0
                            }
                        },
                        "localized": "string"
                    },
                    "kb_article_link": "string",
                    "id": "string"
                }
            ]
        }
    ]
}
string
current_version
Required

Current version of the cluster.

This property was added in vSphere API 7.0.0.0.

array of string
available_versions
Required

Set of available versions can be upgraded to.

This property was added in vSphere API 7.0.0.0.

string As date-time As date-time
last_upgraded_date
Optional

Date of last successful upgrade.

This property was added in vSphere API 7.0.0.0.

If missing or null, the cluster has not yet been upgraded.

messages
Required

Current set of messages associated with the cluster version.

This property was added in vSphere API 7.0.0.0.

string
state
Required

Current state of the upgrade.

For more information see: Vcenter NamespaceManagement Software Clusters State.

This property was added in vSphere API 7.0.0.0.

upgrade_status
Optional

Information about upgrade in progress.

This property was added in vSphere API 7.0.0.0.

If missing or null, the cluster upgrade is not in progress.

upgrade_prechecks
Optional

Detailed information about Supervisor upgrade pre-checks.

This property was added in vSphere API 8.0.3.0.

If missing or null, the cluster pre-checks did not run or supervisor upgrade is not available.